home *** CD-ROM | disk | FTP | other *** search
/ Mac Magazin/MacEasy 12 / Mac Magazin and MacEasy Magazine CD - Issue 12.iso / Sharewarebibliothek / Anwendungen / Wissenschaft & Technik / Yorick / yorick11-nofpu folder / include / README < prev    next >
Text File  |  1995-04-03  |  4KB  |  111 lines
  1.  
  2.      The following include files contain Yorick code built from the
  3.      basic Yorick functions.  These are part of the Yorick distribution,
  4.      and are located in the directory Y_SITE/include.
  5.  
  6.    Special functions:
  7.    ------------------
  8.  
  9.    bessel.i   - integer order Bessel functions
  10.      Functions: bessj, bessy, bessi, bessk
  11.    gamma.i    - gamma function and relatives
  12.      Functions: ln_gamma, beta, bico (binomial coefficients), erfc
  13.    series.i   - geometric series solvers
  14.      Functions: series_s (sum a series), series_r (find ratio given
  15.                 sum and number of terms), series_n (find number of
  16.         terms given sum and ratio)
  17.    ellipse.i  - complete elliptic integrals
  18.      Functions: EllipticE, EllipticK
  19.  
  20.    Data fitting and interpolation:
  21.    -------------------------------
  22.  
  23.    fitlsq.i   - least squares fit a piecewise linear function to data
  24.      Function: fitlsq
  25.    fitrat.i   - rational function and polynomial fits
  26.      Functions: fitrat, fitpol
  27.    spline.i   - cubic spline and tensioned spline interpolation
  28.      Functions: spline, tspline
  29.  
  30.    Numerical integration:
  31.    ----------------------
  32.  
  33.    romberg.i  - Romberg and Simpson adaptive integrators
  34.      Functions: romberg, simpson
  35.    rkutta.i   - Runge-Kutta and Bulirsch-Stoer ODE integrators
  36.      Functions: rkutta, bstoer, rkdumb
  37.  
  38.    I/O functions:
  39.    --------------
  40.  
  41.    copyb.i    - copy a binary file
  42.      Function: copyb
  43.    netcdf.i   - read and write netcdf binary files
  44.      Functions: nc_open, nc_create, nc_vardef, nc_enddef, nc_addrec
  45.                 (if you only need to read a netcdf file, just use openb
  46.          -- netcdf.i will be included automatically)
  47.    prefix.i   - read lists of numbers tagged by a "prefix" at the
  48.                 beginning of each line
  49.      Functions: prefix_find, prefix_read, prefix_write
  50.  
  51.    Graphics:
  52.    ---------
  53.  
  54.    movie.i    - assistance for animation (see demo2.i and demo3.i)
  55.      Functions: movie, movie_stats
  56.    button.i   - implement mouse pushbuttons in a Yorick graphics window
  57.                 (see rezone.i for usage examples)
  58.      Functions: Button, button_plot, button_test, button_build
  59.    plwf.i     - 3-D wire frame plots (painter's algorithm)
  60.      Functions: plwf, plwfset
  61.    pixels.i   - crude attempt to force Yorick to plot cell arrays at
  62.                 one cell per X window pixel
  63.      Functions: pixels, pix_window
  64.  
  65.    Miscellaneous:
  66.    --------------
  67.  
  68.    mkdoc.i    - extract and alphabetize DOCUMENT comments from include files
  69.      Function: mkdoc
  70.    msort.i    - multiple key sorting functions
  71.      Functions: msort, msort_rank
  72.    zroots.i   - find roots of polynomial
  73.      Function: zroot
  74.  
  75.    Demonstration programs:
  76.    -----------------------
  77.  
  78.    demo1.i    - a simple 1-D hydro code
  79.      Functions: demo1, evolve (read the file for more)
  80.    demo2.i    - fancy movies of a drumhead oscillating
  81.                 (solves 2D wave equation on the fly)
  82.      Functions: demo2
  83.    demo3.i    - movie of a chaotic pendulum (way cool)
  84.                 (does Runge-Kutta integration of Lagrangian on the fly)
  85.      Functions: demo3
  86.    demo4.i    - movie of flow around an airfoil
  87.                 (solves for flow field on the fly)
  88.      Functions: demo4
  89.    rezone.i   - point-and-click rezoner for quadrilateral meshes
  90.      Function: rezone, toy_mesh
  91.  
  92.    Test programs:
  93.    --------------
  94.  
  95.    testp.i    - reasonably complete Yorick test suite, except graphics
  96.                 Just include it and the tests run immediately, includes:
  97.      testb.i  - binary file I/O tests
  98.      test1.i  - shock tracker test, poorly vectorizing
  99.      test2.i  - radiation escape factor calculation, highly vectorizing
  100.      test3.i  - scalar arithmetic performance test
  101.    testlp.i   - rough Yorick version of Linpack benchmark
  102.      Function:  testlp
  103.    testg.i    - a few graphics tests (grtest is a crude tutorial)
  104.      Functions: testg, lissajous, grtest
  105.  
  106. Additional functions may be available at your site in the contrib
  107. directory, which is a sibling of this Y_SITE/include directory.  In
  108. Yorick, type:
  109.      Y_SITE
  110. to print the name of the site directory at your site.
  111.